<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
  <meta name="description" content="API docs for the PBKDF2 function from the pbkdf2 library, for the Dart programming language.">
  <title>PBKDF2 function - pbkdf2 library - Dart API</title>


  
  <link rel="preconnect" href="https://fonts.gstatic.com">
  <link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
  <link href="https://fonts.googleapis.com/css2?family=Material+Symbols+Outlined:opsz,wght,FILL,GRAD@48,400,0,0" rel="stylesheet">
  
  <link rel="stylesheet" href="../static-assets/github.css?v1">
  <link rel="stylesheet" href="../static-assets/styles.css?v1">
  <link rel="icon" href="../static-assets/favicon.png?v1">

  
</head>


<body data-base-href="../" data-using-base-href="false" class="light-theme">

<div id="overlay-under-drawer"></div>

<header id="title">
  <span id="sidenav-left-toggle" class="material-symbols-outlined" role="button" tabindex="0">menu</span>
  <ol class="breadcrumbs gt-separated dark hidden-xs">
    <li><a href="../index.html">crypto_dart</a></li>
    <li><a href="../pbkdf2/pbkdf2-library.html">pbkdf2.dart</a></li>
    <li class="self-crumb">PBKDF2 function</li>
  </ol>
  <div class="self-name">PBKDF2</div>
  <form class="search navbar-right" role="search">
    <input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
  <div class="toggle" id="theme-button">
    <label for="theme">
      <input type="checkbox" id="theme" value="light-theme">
      <span id="dark-theme-button" class="material-symbols-outlined">
        brightness_4
      </span>
      <span id="light-theme-button" class="material-symbols-outlined">
        brightness_5
      </span>
    </label>
  </div>
</header>
<main>

  <div
      id="dartdoc-main-content"
      class="main-content"
      data-above-sidebar="pbkdf2&#47;pbkdf2-library-sidebar.html"
      data-below-sidebar="">
      <div>
<h1><span class="kind-function">PBKDF2</span> function 
 
</h1></div>

    <section class="multi-line-signature">
        

<span class="returntype"><a href="https://api.dart.dev/stable/3.3.0/dart-typed_data/Uint8List-class.html">Uint8List</a></span>
<span class="name ">PBKDF2</span>(<wbr><ol class="parameter-list"><li><span class="parameter" id="PBKDF2-param-salt">{<span>required</span> <span class="type-annotation"><a href="https://api.dart.dev/stable/3.3.0/dart-typed_data/Uint8List-class.html">Uint8List</a></span> <span class="parameter-name">salt</span>, </span></li>
<li><span class="parameter" id="PBKDF2-param-password"><span>required</span> <span class="type-annotation">dynamic</span> <span class="parameter-name">password</span>, </span></li>
<li><span class="parameter" id="PBKDF2-param-hasher"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.3.0/dart-core/String-class.html">String</a></span> <span class="parameter-name">hasher</span> = <span class="default-value">&#39;SHA256&#39;</span>, </span></li>
<li><span class="parameter" id="PBKDF2-param-iterations"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.3.0/dart-core/int-class.html">int</a></span> <span class="parameter-name">iterations</span> = <span class="default-value">250000</span>, </span></li>
<li><span class="parameter" id="PBKDF2-param-keySize"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.3.0/dart-core/int-class.html">int</a></span> <span class="parameter-name">keySize</span> = <span class="default-value">4</span>, </span></li>
<li><span class="parameter" id="PBKDF2-param-blockLength"><span class="type-annotation"><a href="https://api.dart.dev/stable/3.3.0/dart-core/int-class.html">int</a>?</span> <span class="parameter-name">blockLength</span>}</span></li>
</ol>)

        

    </section>
    
<section class="desc markdown">
  <p>This function generates a cryptographic password using the PBKDF2 (Password-Based Key Derivation Function 2) algorithm.</p>
<ul>
<li>
<p>hasher The hash function to use. Default is 'SHA256'.</p>
</li>
<li>
<p>iterations The number of iterations to perform. Default is 250000.</p>
</li>
<li>
<p>keySize The size of the password to generate. Default is 4.</p>
</li>
<li>
<p>salt The salt to use in the PBKDF2 algorithm. This is a required parameter.</p>
</li>
<li>
<p>keyEncoding The encoding of the password. Default is 'utf8'.</p>
</li>
<li>
<p>blockLength The length of the block to use in the HMAC. This is a required parameter.</p>
</li>
<li>
<p>password The password to derive the password from. This is a required parameter.</p>
</li>
<li>
<p>returns <a href="https://api.dart.dev/stable/3.3.0/dart-typed_data/Uint8List-class.html">Uint8List</a> The derived password.</p>
</li>
</ul>
</section>


    
<section class="summary source-code" id="source">
  <h2><span>Implementation</span></h2>
  <pre class="language-dart"><code class="language-dart">Uint8List PBKDF2({
  required Uint8List salt,
  required dynamic password,
  String hasher = &#39;SHA256&#39;,
  int iterations = 250000,
  int keySize = 4,
  int? blockLength,
}) {
  final Uint8List _password =
      password is! Uint8List ? UTF8().parse(password) : password;

  final digest = Digest(hasher);

  final pbkdf2 =
      PBKDF2KeyDerivator(HMac(digest, blockLength ?? digest.digestSize * 4));

  pbkdf2.init(Pbkdf2Parameters(salt, iterations, keySize * 8));

  final derivedKey = pbkdf2.process(_password);

  return derivedKey;
}</code></pre>
</section>


  </div> <!-- /.main-content -->

  <div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
    <!-- The search input and breadcrumbs below are only responsively visible at low resolutions. -->
<header id="header-search-sidebar" class="hidden-l">
  <form class="search-sidebar" role="search">
    <input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
  </form>
</header>

<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
    <li><a href="../index.html">crypto_dart</a></li>
    <li><a href="../pbkdf2/pbkdf2-library.html">pbkdf2</a></li>
    <li class="self-crumb">PBKDF2 function</li>
</ol>


    <h5>pbkdf2 library</h5>
    <div id="dartdoc-sidebar-left-content"></div>
  </div><!--/.sidebar-offcanvas-left-->

  <div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
  </div><!--/.sidebar-offcanvas-->

</main>

<footer>
  <span class="no-break">
    crypto_dart
      1.0.3+2
  </span>

  
</footer>



<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/docs.dart.js"></script>



</body>

</html>

